home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 4.iso / public / plan / src / plan.4cat < prev    next >
Text File  |  1994-08-01  |  10KB  |  265 lines
  1.  
  2.  
  3.  
  4.      PPPPLLLLAAAANNNN((((4444LLLL))))                  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                  PPPPLLLLAAAANNNN((((4444LLLL))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           ~/.dayplan - database file of plan(1L)
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  13.           The ~/.dayplan file is read and written by the plan and
  14.           pland programs. It can be edited manually, but it has not
  15.           been designed for this. Generally, the format is annoyingly
  16.           unmnemonic, and there is virtually no error checking. Use at
  17.           your own risk. The only reason I didn't make this a binary
  18.           file is that I hate binary config files as a matter of
  19.           principle.
  20.  
  21.           The type of every line depends on the first character of the
  22.           line. The second character is always a single TAB character.
  23.           All following characters are arguments. Comments and blank
  24.           lines (which are ignored) can appear anywhere. "Header
  25.           types" are all at the beginning of the file before the first
  26.           "entry type".
  27.  
  28.           TYPES THAT CAN APPEAR ANYWHERE:
  29.  
  30.           #    Comment line. The rest of the line is ignored.
  31.  
  32.  
  33.           HEADER TYPES:
  34.  
  35.           o    Options. The argument consists of 12 consecutive flag
  36.                characters, and five numerical arguments.  In order,
  37.                the flags are:
  38.  
  39.                s    sunday first
  40.  
  41.                a    12-hour (am/pm) mode
  42.  
  43.                m    US date format mm/dd/yy
  44.  
  45.                d    auto-delete past options
  46.  
  47.                j    show julian dates
  48.  
  49.                w    show week numbers
  50.  
  51.                n    show the next three notes, rather than the first
  52.                     three
  53.  
  54.                b    numeric warning entry mode, rather than popup mode
  55.  
  56.                w    show advance warnings graphically in week view
  57.  
  58.                u    show user names next to note strings in week view
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 7/11/94)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      PPPPLLLLAAAANNNN((((4444LLLL))))                  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                  PPPPLLLLAAAANNNN((((4444LLLL))))
  71.  
  72.  
  73.  
  74.                -    not used, for future extensions
  75.  
  76.                -    not used, for future extensions
  77.  
  78.                -    not used, for future extensions
  79.  
  80.                After the flags, the default advance-warning times that
  81.                are used when the small buttons at the left edge of the
  82.                advance-warning popup are pressed. The first number is
  83.                the early time, the second the last time. Both are in
  84.                seconds. The third number is the expiration time of
  85.                notifier windows; zero or a missing number means the
  86.                windows live forever, any other number is the maximum
  87.                lifetime in seconds.  The fourth and fifth numbers are
  88.                the hours at the left and right margin of the week
  89.                view; defaults are 8 and 20.
  90.  
  91.           t    Time adjustment parameters as defined with the Adjust
  92.                Time popup. The five numeric parameters are the offset
  93.                to the system clock in seconds, the timezone offset in
  94.                seconds, the DST flag (0=always on, 1=always off,
  95.                2=automatic), and the Julian begin and end dates for
  96.                automatic DST.
  97.  
  98.           e    Early warning flags,
  99.  
  100.           l    Late warning flags, and
  101.  
  102.           a    alarm flags:
  103.                These three have the same format. The first three
  104.                argument chars are flags, as specified in the Alarm
  105.                Options popup. '-' means the flag is off, everything
  106.                else means the flag is on. In order, the flags are:
  107.  
  108.                w    show a color-coded window when the warning/alarm
  109.                     triggers
  110.  
  111.                m    send mail when the warning/alarm triggers
  112.  
  113.                x    execute a command when the warning/alarm triggers
  114.  
  115.                The flags are followed by a single blank. The rest of
  116.                the line is the command to execute when the
  117.                warning/alarm triggers and the 'x' flag is on.
  118.  
  119.           p    The print spooling string. When printing a PostScript
  120.                calendar, the PostScript code is sent to stdin of this
  121.                command.
  122.  
  123.           m    The mailer program, as specified in the Alarm Options
  124.                menu. Up to one "%s" is allowed, it is replaced by the
  125.                (quoted) note string.  "%s" is typically used for a
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 7/11/94)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      PPPPLLLLAAAANNNN((((4444LLLL))))                  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                  PPPPLLLLAAAANNNN((((4444LLLL))))
  137.  
  138.  
  139.  
  140.                subject.
  141.  
  142.           U    Global user list parameters. Currently, there is only
  143.                one integer argument; the number of users (the number
  144.                of 'u' lines following).  The user list is the list of
  145.                "friends" whose public appointments appear in the week
  146.                view.
  147.  
  148.           u    One user in the user list. There are four arguments:
  149.  
  150.                -    the user name
  151.  
  152.                -    the user's home directory
  153.  
  154.                -    0 if the user is shown, 1 if the user is suspended
  155.  
  156.                -    the color used in the week view, a number in the
  157.                     range 0..7
  158.  
  159.  
  160.           ENTRY TYPES:
  161.  
  162.           [0-9]
  163.                Begins an entry. This is the only mandatory line, all
  164.                others that follow are optional. All following lines
  165.                that do not begin with a numeric digit are extra
  166.                information for the entry. Unlike all other types,
  167.                there is no TAB character in the second column, the
  168.                first character is the first digit of the trigger date.
  169.  
  170.                The line consists of five date/time fields, seperated
  171.                by at least one blank, and three flag characters that
  172.                must be consecutive. As usual, flags are off if the
  173.                character is '-', and on otherwise. The fields are:
  174.  
  175.                1/2/3    trigger date, month/day/year. Year can be
  176.                         either 70..99,00..38, or 1970..2038.  Do not
  177.                         enter appointments after 2037. If there is
  178.                         demand, I'll fix this bug in about 45 years.
  179.  
  180.                1:2:3    trigger time, hour:minutes:seconds, in 24-hour
  181.                         format. 99:99:99 means that there is no alarm
  182.                         time ("-" in the time column).
  183.  
  184.                1:2:3    length, hour:minutes:seconds, in 24-hour
  185.                         format
  186.  
  187.                1:2:3    early-warning time, hour:minutes:seconds, in
  188.                         24-hour format, 0:0:0 means there is no early
  189.                         warning
  190.  
  191.                1:2:3    late-warning time, hour:minutes:seconds, in
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 7/11/94)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      PPPPLLLLAAAANNNN((((4444LLLL))))                  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                  PPPPLLLLAAAANNNN((((4444LLLL))))
  203.  
  204.  
  205.  
  206.                         24-hour format, 0:0:0 means there is no late
  207.                         warning
  208.  
  209.                S        suspended (the green button at the left edge
  210.                         is off)
  211.  
  212.                P        private (goes into the private dayplan file
  213.                         that has mode 0600)
  214.  
  215.                N        no alarm (trigger warnings if nonzero, but no
  216.                         final alarm)
  217.  
  218.           R    Add repetition information to the current entry. There
  219.                are five numeric fields, separated by at least one
  220.                blank. This one is particularly unsuited for human
  221.                consumption, sorry.
  222.  
  223.                1    trigger alarm every <1> days (in seconds)
  224.  
  225.                2    delete alarm after this date (seconds since 1/1/70
  226.                     0:00:00)
  227.  
  228.                3    weekday bitmap and nth-week bitmap:
  229.                     bit0=sunday ... bit6=saturday
  230.                     bit8=first ... bit12=fifth, bit13=last
  231.  
  232.                4    month day bitmap, bit0=last day of the month, bits
  233.                     1..31=on that day of the month
  234.  
  235.                5    if 1, the entry repeats every year; if 0, it
  236.                     doesn't.
  237.  
  238.           N    Add a note string to the current entry. All characters
  239.                that follow the TAB are part of the note string.
  240.  
  241.           M    Add another line to the current entry's message. All
  242.                characters that follow the TAB are part of the line.
  243.                There can be multiple M lines, they all add to the
  244.                message.
  245.  
  246.           S    Add another line to the current entry's script. All
  247.                characters that follow the TAB are part of the line.
  248.                There can be multiple S lines, they all add to the
  249.                script.
  250.  
  251.           G    Reserved for group meetings, not currently used.
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 7/11/94)
  262.  
  263.  
  264.  
  265.